CLI-1745: Resolve `$ref` in `requestBody` and property `schema` for `api:private-networks:create` command. by vishalkhode1 · Pull Request #1973 · acquia/cli

vishalkhode1 · 2026-03-13T07:07:43Z

Motivation
Fixes Undefined array key "type" warning that appears when running command acli api:private-networks:create.

Proposed changes

Resolve $ref in requestBody object before processing parameters. For ex:

"requestBody": {
  "$ref": "#/components/requestBodies/Private_Network_Service_API_PrivateNetworkCreateRequest"
},

Resolve $ref in individual property definitions from requestBody schema. For ex:

"isolation": {
  "$ref": "#/components/schemas/Private_Network_Service_API_Isolation"
},
"ingress": {
  "$ref": "#/components/schemas/Private_Network_Service_API_Ingress"
},
"connections": {
  "$ref": "#/components/schemas/Private_Network_Service_API_Connections"
}

Add fallback to read example from schema.example for $ref resolved requestBodies.
Use getParamType() helper in castParamType() instead of direct $paramSpec['type'] access to fix "Undefined array key type" warning.

Alternatives considered
N/A.

Testing steps

Run command ./bin/acli api:private-networks:create --help and you should proper example as added in acquia-spec.json.
Run below command and you shouldn't see any warning

./bin/acli api:private-networks:create "123e4567-e89b-12d3-a456-426614174000" "us-east-1" "customer-private-network" --description="Private network for customer" --label="anyLabel" --isolation="{"dedicated_compute":false,"dedicated_network":false}" --ingress="{"drupal_ssh":{"ingress_acls":["test-acls"]}}" "{"cidr":"114.7.55.1\/16","private_egress_access":{"drupal":true},"vpns":[{"name":"vpn1","gateway_ip":"10.10.10.10","routes":["127.0.0.1\/32","127.0.0.2\/32"],"tunnel1":{"shared_key":"sharedKey1","internal_cidr":"192.1.1.0\/24","ike_versions":"1","startup_action":"start","dpd_timeout_action":"stop"},"tunnel2":{"shared_key":"sharedKey2","internal_cidr":"192.1.1.0\/14","ike_versions":"1","startup_action":"start","dpd_timeout_action":"stop"}}],"vpc_peers":[{"name":"vpcPeer1","aws_account":"123456789012","vpc_id":"vpc-1234567890abcdef0","vpc_cidr":"120.24.16.1\/24"}]}"

Follow the contribution guide to set up your development environment or download a pre-built acli.phar for this PR.
If running from source, clear the kernel cache to pick up new and changed commands: ./bin/acli ckc
Check for regressions: (add specific steps for this pr)
Check new functionality: (add specific steps for this pr)

codecov · 2026-03-13T07:09:00Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.34%. Comparing base (064b748) to head (2e51bf3).

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #1973   +/-   ##
=========================================
  Coverage     92.33%   92.34%           
- Complexity     1932     1940    +8     
=========================================
  Files           122      122           
  Lines          7035     7051   +16     
=========================================
+ Hits           6496     6511   +15     
- Misses          539      540    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2026-03-13T07:09:56Z

Try the dev build for this PR: https://acquia-cli.s3.amazonaws.com/build/pr/1973/acli.phar

curl -OL https://acquia-cli.s3.amazonaws.com/build/pr/1973/acli.phar
chmod +x acli.phar

Copilot

Pull request overview

Fixes warnings and improves parameter/example handling for generated API CLI commands when the OpenAPI spec uses $ref in requestBody and in request-body property schemas (notably for api:private-networks:create).

Changes:

Resolve $ref at the requestBody level and for $ref’d properties within the request-body schema before building CLI parameters.
Add fallback support for requestBody examples located at content.<type>.schema.example (common with $ref-based requestBodies).
Use getParamType() in castParamType() to avoid "Undefined array key type" warnings for array types.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
`src/Command/Api/ApiCommandHelper.php`	Adds `$ref` resolution for request bodies/properties and improves example extraction for usage generation.
`src/Command/Api/ApiBaseCommand.php`	Uses `getParamType()` to avoid direct access to missing `type` keys during casting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/Command/Api/ApiCommandHelper.php

…or API commands.

Copilot

Pull request overview

Fixes warnings and improves requestBody parameter handling for generated API CLI commands, especially when OpenAPI requestBody and its properties are defined via $ref (notably for api:private-networks:create).

Changes:

Resolve $ref at the requestBody level before processing request body parameters.
Resolve $ref within individual requestBody schema properties to ensure a usable spec (incl. type) downstream.
Extend example discovery to also read content.*.schema.example (in addition to content.*.example) and update PHPUnit coverage for the private networks create command.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
tests/phpunit/src/Commands/Api/ApiCommandTest.php	Adds coverage for `$ref` requestBody example extraction and the private-networks create usage expectation.
src/Command/Api/ApiCommandHelper.php	Adds `$ref` resolution for requestBodies and property schemas; falls back to `schema.example` for usage generation.
src/Command/Api/ApiBaseCommand.php	Uses `getParamType()` in `castParamType()` to avoid undefined `type` access.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/phpunit/src/Commands/Api/ApiCommandTest.php

src/Command/Api/ApiCommandHelper.php

…x it.

…tests.

shriacquia · 2026-03-17T06:11:14Z

@anujkaushal - could you review this today?

anujkaushal

Its not breaking so.. looks good to me.

anujkaushal · 2026-03-17T19:28:05Z

@Roy19 @ashish-kharode can you please verify the change.

Copilot AI review requested due to automatic review settings March 13, 2026 07:07

Copilot started reviewing on behalf of vishalkhode1 March 13, 2026 07:08 View session

vishalkhode1 changed the title ~~CLI-1745: fix: resolve pointers in requestBody and property schemas for API commands.~~ CLI-1745: fix: resolve pointers in requestBody and property schemas for api:private-networks:create command. Mar 13, 2026

vishalkhode1 changed the title ~~CLI-1745: fix: resolve pointers in requestBody and property schemas for api:private-networks:create command.~~ CLI-1745: fix: resolve $ref in requestBody and property schema for api:private-networks:create command. Mar 13, 2026

Copilot AI reviewed Mar 13, 2026

View reviewed changes

src/Command/Api/ApiCommandHelper.php Outdated Show resolved Hide resolved

src/Command/Api/ApiCommandHelper.php Outdated Show resolved Hide resolved

src/Command/Api/ApiCommandHelper.php Show resolved Hide resolved

src/Command/Api/ApiCommandHelper.php Outdated Show resolved Hide resolved

CLI-1745: fix: resolve pointers in requestBody and property schemas f…

165524f

…or API commands.

vishalkhode1 force-pushed the main branch from 643f69a to 165524f Compare March 13, 2026 09:47

vishalkhode1 requested a review from Copilot March 13, 2026 09:52

Copilot started reviewing on behalf of vishalkhode1 March 13, 2026 09:52 View session

vishalkhode1 changed the title ~~CLI-1745: fix: resolve $ref in requestBody and property schema for api:private-networks:create command.~~ CLI-1745: Resolve $ref in requestBody and property schema for api:private-networks:create command. Mar 13, 2026

Copilot AI reviewed Mar 13, 2026

View reviewed changes

tests/phpunit/src/Commands/Api/ApiCommandTest.php Outdated Show resolved Hide resolved

src/Command/Api/ApiCommandHelper.php Show resolved Hide resolved

src/Command/Api/ApiCommandHelper.php Outdated Show resolved Hide resolved

vishalkhode1 added 3 commits March 13, 2026 15:46

Removed the duplicate check code as suggested by co-pilot.

37e7835

Fixed the issue as suggested by co-pilot.

b9f54e2

Ignored failing mutation tests as it requires a seperate ticket to fi…

02efa86

…x it.

jigar-shah-acquia added the enhancement label Mar 13, 2026

jigar-shah-acquia requested review from anujkaushal and jigar-shah-acquia March 13, 2026 13:31

jigar-shah-acquia assigned vishalkhode1 Mar 13, 2026

jigar-shah-acquia approved these changes Mar 16, 2026

View reviewed changes

vishalkhode1 added 2 commits March 16, 2026 12:52

Remove infection ignore to validate if CI is failing due to mutation …

636d65a

…tests.

Fixed minor issue and added more test coverage to fix mutation tests.

2e51bf3

anujkaushal approved these changes Mar 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLI-1745: Resolve `$ref` in `requestBody` and property `schema` for `api:private-networks:create` command.#1973

CLI-1745: Resolve `$ref` in `requestBody` and property `schema` for `api:private-networks:create` command.#1973
vishalkhode1 wants to merge 6 commits intoacquia:mainfrom
vishalkhode1:main

vishalkhode1 commented Mar 13, 2026

Uh oh!

codecov bot commented Mar 13, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shriacquia commented Mar 17, 2026

Uh oh!

anujkaushal left a comment

Uh oh!

anujkaushal commented Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

vishalkhode1 commented Mar 13, 2026

Uh oh!

codecov bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shriacquia commented Mar 17, 2026

Uh oh!

anujkaushal left a comment

Choose a reason for hiding this comment

Uh oh!

anujkaushal commented Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Mar 13, 2026 •

edited

Loading